corefoundation.htmlHTMLudog‰xπùΔ¢πùΔ¢ÅÅB Monkeybread Realbasic plugin - Documentation - CoreFoundation

MBS Plugin Documentation

This is the documentation for the Realbasic Plugins from Monkeybreadsoftware.de. You find these plugins and the newest version of this document at http://www.monkeybreadsoftware.de/realbasic inside the plugins section.

This help was last updated on Freitag, 6. September 2002 and covers 2136 items: 126 classes, 2 controls and 583 global functions.

The list of the themes Global methods by category Global methods by name The list of the classes The list of the controls

CreateStringByAddingPercentEscapes(original as CFString,charactersToLeaveEscaped as CFString,legalURLCharactersToBeEscaped as CFString,encoding as integer) as CFString

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Addes percent escapes inside a string.
Notes: If charactersToLeaveEscaped=nil then no string is changed. If charactersToLeaveEscaped contains an emptry string ("") all escapes are changed and if charactersToLeaveEscaped contains a string<>"" then this characters are not escaped.

CreateStringByReplacingPercentEscapes(original as CFString,charactersToLeaveEscaped as CFString) as "CFString

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Replaces percent escapes inside a string.
Notes: If charactersToLeaveEscaped=nil then no string is changed. If charactersToLeaveEscaped contains an emptry string ("") all escapes are changed and if charactersToLeaveEscaped contains a string<>"" then this characters are not escaped.

GetPredefinedCFCharacterSet(id as integer) as CFCharacterSet

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: -> 0. Mac OS Carbon: Works. Windows: -> 0.
Function: Returns a predefined Character set.

kCFArrayTypeID as integer

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: -> 0. Mac OS Carbon: Works. Windows: -> 0.
Function: Returns the Type ID of a CFArray object.

kCFBagTypeID as integer

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: -> 0. Mac OS Carbon: Works. Windows: -> 0.
Function: Returns the Type ID of a CFBag object.

kCFBinaryTypeID as integer

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: -> 0. Mac OS Carbon: Works. Windows: -> 0.
Function: Returns the Type ID of a CFBinary object.

kCFBooleanTypeID as integer

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: -> 0. Mac OS Carbon: Works. Windows: -> 0.
Function: Returns the Type ID of a CFBoolean object.

kCFCharacterSetAlphaNumeric as integer

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Works.
Function: Returns the ID of the predefined character set for alpha numeric characters.

kCFCharacterSetControl as integer

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Works.
Function: Returns the ID of the predefined character set for control characters.

kCFCharacterSetDecimalDigit as integer

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Works.
Function: Returns the ID of the predefined character set for decimal digit characters.

kCFCharacterSetDecomposable as integer

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Works.
Function: Returns the ID of the predefined character set for decomposable characters.

kCFCharacterSetIllegal as integer

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Works.
Function: Returns the ID of the predefined character set for illegal characters.

kCFCharacterSetLetter as integer

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Works.
Function: Returns the ID of the predefined character set for letter characters.

kCFCharacterSetLowercaseLetter as integer

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Works.
Function: Returns the ID of the predefined character set for lowercase letter characters.

kCFCharacterSetNonBase as integer

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Works.
Function: Returns the ID of the predefined character set for non base characters.

kCFCharacterSetPunctuation as integer

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Works.
Function: Returns the ID of the predefined character set for punctuation characters.

kCFCharacterSetTypeID as integer

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: -> 0. Mac OS Carbon: Works. Windows: -> 0.
Function: Returns the Type ID of a CFCharacterSet object.

kCFCharacterSetUppercaseLetter as integer

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Works.
Function: Returns the ID of the predefined character set for uppercase letter characters.

kCFCharacterSetWhitespace as integer

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Works.
Function: Returns the ID of the predefined character set for whitespace characters.

kCFCharacterSetWhitespaceAndNewline as integer

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: Works. Mac OS Carbon: Works. Windows: Works.
Function: Returns the ID of the predefined character set for whitespace characters and newline.

kCFDateTypeID as integer

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: -> 0. Mac OS Carbon: Works. Windows: -> 0.
Function: Returns the Type ID of a CFDate object.

kCFDictionaryTypeID as integer

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: -> 0. Mac OS Carbon: Works. Windows: -> 0.
Function: Returns the Type ID of a CFDictionary object.

kCFNumberNaN as CFNumber

global method, CoreFoundation Mi, 24. Jul 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns a CFNumber object for NaN (not a number).

kCFNumberNegativeInfinity as CFNumber

global method, CoreFoundation Mi, 24. Jul 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns a CFNumber object for negative infinity.

kCFNumberPositiveInfinity as CFNumber

global method, CoreFoundation Mi, 24. Jul 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns a CFNumber object for positive infinity.

kCFNumberTypeID as integer

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: -> 0. Mac OS Carbon: Works. Windows: -> 0.
Function: Returns the Type ID of a CFNumber object.

kCFSetTypeID as integer

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: -> 0. Mac OS Carbon: Works. Windows: -> 0.
Function: Returns the Type ID of a CFSet object.

kCFStringTypeID as integer

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: -> 0. Mac OS Carbon: Works. Windows: -> 0.
Function: Returns the Type ID of a CFString object.

kCFURLTypeID as integer

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: -> 0. Mac OS Carbon: Works. Windows: -> 0.
Function: Returns the Type ID of a CFURL object.

NewCFArrayHandle(handle as integer,release as boolean) as CFArray

global method, CoreFoundation So, 18. Aug 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns a CFArray object for the given handle.
Notes:
Handle is just a CFArrayRef.
If release is true, the destructor of the CFArray will release the handle later.

NewCFBagHandle(handle as integer,release as boolean) as CFBag

global method, CoreFoundation So, 18. Aug 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns a CFBag object for the given handle.
Notes:
Handle is just a CFBagRef.
If release is true, the destructor of the CFBag will release the handle later.

NewCFBinaryHandle(handle as integer,release as boolean) as CFBinary

global method, CoreFoundation So, 18. Aug 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns a CFBinary object for the given handle.
Notes:
Handle is just a CFDataRef.
If release is true, the destructor of the CFBinary will release the handle later.

NewCFBinaryMem(mem as memoryblock,len as integer) as CFBinary

global method, CoreFoundation So, 18. Aug 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns a CFBinary object for the given memoryblock.

NewCFBinaryStr(s as string) as CFBinary

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns a CFBinary object for the given string.

NewCFBoolean(s as boolean) as CFBoolean

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns a CFBoolean object created using the given boolean.

NewCFBooleanHandle(handle as integer,release as boolean) as CFBoolean

global method, CoreFoundation So, 18. Aug 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns a CFBoolean object for the given handle.
Notes:
Handle is just a CFBooleanRef.
If release is true, the destructor of the CFBoolean will release the handle later.

NewCFCharacterSetCFBinary(str as CFBinary) as CFCharacterSet

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns a Character set with characters inside the CFBinary object.

NewCFCharacterSetCFString(str as CFString) as CFCharacterSet

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns a Character set with characters inside the CFString object.

NewCFCharacterSetRange(min as integer, max as integer) as CFCharacterSet

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns a Character set with chars between min and max.
Notes: Use Unicode charcodes for min and max.

NewCFDate as CFDate

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns a new emptry CFDate.

NewCFDateHandle(handle as integer,release as boolean) as CFDate

global method, CoreFoundation So, 18. Aug 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns a CFDate object for the given handle.
Notes:
Handle is just a CFDateRef.
If release is true, the destructor of the CFDate will release the handle later.

NewCFDictionaryHandle(handle as integer,release as boolean) as CFDictionary

global method, CoreFoundation So, 18. Aug 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns a CFDictionary object for the given handle.
Notes:
Handle is just a CFDictionaryRef.
If release is true, the destructor of the CFDictionary will release the handle later.

NewCFMutableArray as CFMutableArray

global method, CoreFoundation Di, 23. Jul 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Creates a new empty mutable array.
Notes: The array's maximum capacity is unlimited (or rather, only limited by address space and available memory constraints).

NewCFMutableArrayHandle(handle as integer,release as boolean) as CFMutableArray

global method, CoreFoundation So, 18. Aug 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns a CFMutableArray object for the given handle.
Notes:
Handle is just a CFMutableArrayRef.
If release is true, the destructor of the CFMutableArray will release the handle later.

NewCFMutableBag as CFMutableBag

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns a new emptry CFMutableBag.

NewCFMutableBagHandle(handle as integer,release as boolean) as CFMutableBag

global method, CoreFoundation So, 18. Aug 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns a CFMutableBag object for the given handle.
Notes:
Handle is just a CFMutableBagRef.
If release is true, the destructor of the CFMutableBag will release the handle later.

NewCFMutableBinary(size as integer) as CFMutableBinary

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns a CFMutableBinary object with the given size in bytes.

NewCFMutableBinaryHandle(handle as integer,release as boolean) as CFMutableBinary

global method, CoreFoundation So, 18. Aug 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns a CFMutableBinary object for the given handle.
Notes:
Handle is just a CFMutableDataRef.
If release is true, the destructor of the CFMutableBinary will release the handle later.

NewCFMutableDictionary as CFMutableDictionary

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns a new emptry CFMutableDictionary.

NewCFMutableDictionaryHandle(handle as integer,release as boolean) as CFMutableDictionary

global method, CoreFoundation So, 18. Aug 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns a CFMutableDictionary object for the given handle.
Notes:
Handle is just a CFMutableDictionaryRef.
If release is true, the destructor of the CFMutableDictionary will release the handle later.

NewCFMutableSet as CFMutableSet

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns a new emptry CFMutableSet.

NewCFMutableSetHandle(handle as integer,release as boolean) as CFMutableSet

global method, CoreFoundation So, 18. Aug 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns a CFMutableSet object for the given handle.
Notes:
Handle is just a CFMutableSetRef.
If release is true, the destructor of the CFMutableSet will release the handle later.

NewCFMutableStringHandle(handle as integer,release as boolean) as CFMutableString

global method, CoreFoundation So, 18. Aug 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns a CFMutableString object for the given handle.
Notes:
Handle is just a CFMutableStringRef.
If release is true, the destructor of the CFMutableString will release the handle later.

NewCFNumberDouble(d as Double) as CFNumber

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns a CFNumber object for the given double value.

NewCFNumberHandle(handle as integer,release as boolean) as CFNumber

global method, CoreFoundation So, 18. Aug 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns a CFNumber object for the given handle.
Notes:
Handle is just a CFNumberRef.
If release is true, the destructor of the CFNumber will release the handle later.

NewCFNumberInteger(i as integer) as CFNumber

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns a CFNumber object for the given integer value.

NewCFNumberSingle(i as single) as CFNumber

global method, CoreFoundation Mi, 24. Jul 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns a CFNumber object for the given single value.

NewCFObjectHandle(handle as integer,release as boolean) as CFObject

global method, CoreFoundation So, 18. Aug 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns a CFObject object for the given handle.
Notes:
Handle is just a CFTypeRef.
If release is true, the destructor of the CFObject will release the handle later.

NewCFSetHandle(handle as integer,release as boolean) as CFSet

global method, CoreFoundation So, 18. Aug 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns a CFSet object for the given handle.
Notes:
Handle is just a CFSetRef.
If release is true, the destructor of the CFSet will release the handle later.

NewCFString(s as string) as CFString

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns a CFString object created using the given string.
Notes: The string may contain unicode.

NewCFStringHandle(handle as integer,release as boolean) as CFString

global method, CoreFoundation So, 18. Aug 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns a CFString object for the given handle.
Notes:
Handle is just a CFStringRef.
If release is true, the destructor of the CFString will release the handle later.

NewCFURLCFString(cfstr as CFString) as "CFURL

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Creates a new CFURL from the CFString.

NewCFURLHandle(handle as integer,release as boolean) as CFURL

global method, CoreFoundation So, 18. Aug 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Returns a CFURL object for the given handle.
Notes:
Handle is just a CFURLRef.
If release is true, the destructor of the CFURL will release the handle later.

NewCFURLHFSPath(cfstr as CFString,directory as boolean) as CFURL

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Creates a new CFURL from the CFString which is interpreted as a HFS path.

NewCFURLMem(mem as memoryblock,len as integer,encoding as integer,baseurl as CFURL) as CFURL

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Creates a new CFURL from the data inside the memoryblock.
Notes:
Len is the len of the data inside the memoryblock.
Encoding the ID of the text encoding.
BaseURL is the base url. If baseurl=nil then the current application directory is used.

NewCFURLPosixPath(cfstr as CFString,directory as boolean) as CFURL

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Creates a new CFURL from the CFString which is interpreted as a Posix path.

NewCFURLStr(str as string,baseurl as CFURL) as CFURL

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Creates a new CFURL from the string.
Notes: BaseURL is the base url. If baseurl=nil then the current application directory is used.

NewCFURLWindowsPath(cfstr as CFString,directory as boolean) as CFURL

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Creates a new CFURL from the CFString which is interpreted as a Windows path.

NewPropertyListFromXML(XML as CFBinary) as CFObject

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: -> nil. Mac OS Carbon: Works. Windows: -> nil.
Function: Parses the XML data and returns a CFPropertyList.
Notes: returns a CFPropertyList if successfull or a CFString with a human readable error message.

TypeIDDescription(TypeID as integer) as CFString

global method, CoreFoundation So, 21. Jul 2002
Mac OS Classic: -> 0. Mac OS Carbon: Works. Windows: -> 0.
Function: Returns a string with the name for the CoreFoundation data type.
Notes: e.g. "CFString" for a CFString.

Contact

Written 2002 by Christian Schmitz. Feel free to ask or report mistakes to realbasic@macsw.de.
Thanks.

This resource fork intentionally left blank ˇˇ